home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sprscn3.zip / SUPRSCAN.DOC < prev    next >
Text File  |  1992-01-08  |  9KB  |  203 lines
  1.  
  2.                                 SUPRSCAN
  3.                                 ++++++++
  4.  
  5.                     version 3.05, by Michael Conley
  6.     released  01/08/92 from the Charlatan's Cabin BBS, Los Angeles, CA.
  7.  
  8. SUPRSCAN is designed to be run as a live DOOR program on Wildcat! 3.x and 2.x 
  9. systems. It allows your users to search through any BBS lists you provide,
  10. by simply unzipping them and placing the TEXT files in a directory you define
  11. in the configuration file for SUPRSCAN.  Depending on list format, they may
  12. search for Area Code, State, or a key word or phrase.
  13.  
  14. SETTING UP A DOOR:
  15. ================== 
  16. The Wildcat! manual and other tutorials have done a fine job of explaining
  17. how to set up a door on your BBS.  Therefore I won't re-invent the wheel by
  18. going through all of the directory naming and batch file creating necessary
  19. to execute SUPRSCAN.  
  20.  
  21. It's important to note that SUPRSCAN will check the CURRENT directory (where
  22. your DOOR program is started) for either DOOR.SYS or CALLINFO.BBS.  Wildcat!
  23. version 3.x creates DOOR.SYS; earlier versions created CALLINFO.BBS.  On my
  24. system, I have a directory called DOORS, and my batch file copies DOOR.SYS
  25. into that directory, then change to that directory, then start SUPRSCAN.
  26.  
  27. SuperScan also needs ENVIRONMENT VARIABLES:  These are used by Wildcat! 3.x
  28. and will be ignored by Wildcat! 2.x, but they MUST be present for each node
  29. of your Wildcat! system in order for SuperScan to function properly:
  30.  
  31. SET WCPORTID=2     < put these lines in your Wildcat! startup batch file and
  32. SET WCIRQID=3      <   check to be sure they are added to your environment.
  33.  
  34. If you have a non-standard port address, you'll need to provide an additional
  35. environment variable with the DECIMAL port address:
  36.  
  37. SET COMBASE=1016  << substitute your correct decimal port address here.
  38.  
  39. That will override the default address of the port number specified in 
  40. WCPORTID.   WCIRQID will still need to be set to the correct interrupt
  41. value.  SuperScan supports IRQs in the range 2-7.
  42.  
  43. A sample batch file for Wildcat! version 3.x would look something like this:
  44.  
  45. REM this is a sample batch file for SUPRSCAN with Wildcat! 3.x
  46. REM this assumes you SHELL to your doors.  If you TERMINATE, you
  47. REM need to add a change-directory back to your startup directory
  48. REM and then run your startup batch file.
  49. ECHO OFF
  50. COPY C:\WC30\WCWORK\NODE%WCNODEID%\DOOR.SYS C:\WC30\DOORS\DOOR.SYS
  51. CD C:\WC30\DOORS\DOOR.SYS
  52. SUPRSCAN
  53. EXIT    
  54.  
  55. A sample batch file for Wildcat! version 2.x would look something like this:
  56.  
  57. REM this is a sample batch file for SUPRSCAN with Wildcat! 2.x
  58. ECHO OFF
  59. CD \DOORS
  60. COPY C:\CAT\NODE1\CALLINFO.BBS C:\DOORS\CALLINFO.BBS
  61. SUPRSCAN
  62. CD \CAT\NODE1
  63. NODE1.BAT
  64.  
  65. Note that SUPRSCAN monitors time online and Carrier Detect, and will close
  66. and exit gracefully back to the node if the caller drops offline while in
  67. the door.
  68.  
  69. PREPARING SUPRSCAN:
  70. ===================
  71. It's necessary to create a configuration file for SUPRSCAN, named SUPRSCAN.CFG,
  72. which must reside in the directory where you'll start SUPRSCAN.  Here is a
  73. sample configuration file:
  74.  
  75. BBSNAME=The Charlatan's Cabin BBS
  76. CTSCHECK=YES
  77. LISTPATH=C:\WC30\DOORS
  78.  
  79. LISTNAME=The Southern California BBS List
  80. LISTFILE=SOCAL???.LST
  81. HEADERLINES=5
  82. STARTMARK= =============
  83. AREACOLUMN=3
  84. STATECOLUMN=0
  85.  
  86. LISTNAME=Listing of 9600 baud BBSes
  87. LISTFILE=96LIST??.TXT
  88. HEADERLINES=3
  89. STARTMARK= -----------------
  90. AREACOLUMN=1
  91. STATECOLUMN=59
  92.  
  93.  
  94. You may edit this file as desired, following these guidelines:
  95.  
  96.         BBSNAME= The name of your BBS as you want it to appear in
  97.                  the program's displays.
  98.  
  99.         CTSCHECK= Indicate YES or NO ... do you want the program to
  100.                   check for Clear to Send?  Default is YES if this
  101.                   line isn't found.
  102.         
  103.         LISTPATH= The complete Path to your BBS lists.
  104.  
  105. Next, you'll need to set up configuration information for each BBS list
  106. you want to support in SuperScan.  NOTE: You'll need to place ALL of the
  107. lists in the directory defined in LISTPATH.
  108.  
  109. A maximum of 9 BBS lists may be included ... any beyond that will be
  110. ignored.
  111.  
  112. For each BBS list, create a block of entries consisting of these six lines:
  113.  
  114.         LISTNAME= The name of the list as you want it displayed on the
  115.                   menu screen.
  116.  
  117.         LISTFILE= The name of the BBS list file itself.  Reasonable 
  118.                   wildcards are acceptable, such as "SOCAL???.LST" The
  119.                   program's search routine will display the first 
  120.                   matching file, so be sure to delete old ones when you
  121.                   receive a new list.
  122.  
  123.         HEADERLINES= Indicates how many lines from the very top of the
  124.                      list file you want to display.  This might include
  125.                      the name of the list, the compilation date, and
  126.                      perhaps some information as to how the listing is
  127.                      coded.  I suggest you keep this to a fairly small
  128.                      number because this info will be displayed each
  129.                      time a search is initiated on a particular list.
  130.  
  131.         STARTMARK= This is a little tricky ... it is a "text sample" of 
  132.                    a line in the file, after which you want to start the
  133.                    search.  Many lists have long headers including sample
  134.                    listings which you don't want to include in the search.
  135.                    Then, there will be a "tear-bar" or some keyword that
  136.                    will indicate the beginning of the real list.  Put a
  137.                    unique chunk of that line after the STARTMARK option to
  138.                    control where the search begins.  Typically, a short line
  139.                    of hyphens is often used, and the option might look
  140.                    something like this:  STARTMARK=---------------
  141.  
  142.         AREACOLUMN= This indicates the column in which the area code is
  143.                     listed.  The program will look for an exact match of
  144.                     the three-digit area code requested by the user, 
  145.                     beginning in this column.  To disable this option, set
  146.                     the value to 0, and the search mode will not be offered.
  147.                     BE SURE TO TEST these options whenever you add or update 
  148.                     a list, as minor format changes can "break" SuperScan.
  149.  
  150.         STATECOLUMN= This indicates the column in which to begin looking for
  151.                      the state abbreviation. The program will look for an 
  152.                      exact match of the two-letter state abbreviation requested 
  153.                      by the user, anywhere between this column and the end of
  154.                      the line.  It will perform an "intelligent" search, 
  155.                      looking for either a SPACE or a COMMA before the state,
  156.                      reducing the chances of bogus matches.
  157.                      BE SURE TO TEST these options whenever you add or update 
  158.                      a list, as minor format changes can "break" SuperScan.
  159.  
  160. It's important to note that the block of options for each list must be filled
  161. out completely, or SuperScan may produce unpredictable results!  Also, be sure
  162. to keep them in the order shown above.  Do NOT omit any lines or SuperScan
  163. will reject the configuration file.        
  164.  
  165.  
  166. ------------------------------------------------------------------
  167. PROBLEMS, SUGGESTIONS:
  168.  
  169. This program is public domain.  I don't seek or accept any donations for 
  170. this  or any of my other Wildcat! utility programs, including TODAYBBS, 
  171. FLOP, MSTAT, USTAT, and others.
  172.  
  173. I welcome suggestions, and will try to help (no guarantees) if there are
  174. problems.
  175.  
  176. You may contact me at The Charlatan's Cabin BBS  (213) 654-7337.  Mention
  177. your Wildcat! registration number in the comment and you'll be upgraded to
  178. visiting sysop level without the usually required registration by mail.
  179.  
  180. You may also leave a message via CompuServe EMail. My CompuServe account 
  181. number is 70250,220.  I also regularly check the Mustang Software head-
  182. quarters BBS, especially the "3rd Party Utilities Help" conference.
  183.  
  184. Please, NO VOICE CALLS.  This isn't meant to be unfriendly, but with the 
  185. price of public domain software these days ... I just can't afford to be 
  186. "on call."  I WILL respond to your questions via my BBS or CompuServe,
  187. or via the Mustang Software registered SysOp BBS.
  188.  
  189. Version history:
  190.  
  191. 3.00     11/16/91       First release compatible with Wildcat! 3.x as well
  192.                         as Wildcat! 2.x
  193. 3.01     11/22/91       Minor update ... added parsing to display time left
  194.                         on sysop window at bottom of screen for systems 
  195.                         using DOOR.SYS
  196. 3.02     11/24/91       Added support for non-standard port addresses.
  197. 3.03     12/04/91       Minor enhancement to STATE search routine.
  198. 3.04     12/08/91       Minor bug fix to handle backspace from remote when
  199.                         input line is empty.
  200. 3.05     01/08/92       Minor bug fix to correct menu display when the   
  201.                         maximum of 9 lists were configured.
  202.  
  203.